home *** CD-ROM | disk | FTP | other *** search
/ PC World 2008 September / PCWorld_2008-09_cd.bin / multimedia / tuxpaint / tuxpaint-0.9.20-win32-installer.exe / {app} / docs / INSTALL.txt < prev    next >
Text File  |  2008-07-01  |  15KB  |  401 lines
  1. INSTALL.txt for Tux Paint
  2.  
  3. Tux Paint - A simple drawing program for children.
  4.  
  5. Copyright 2002-2007 by Bill Kendrick and others
  6. bill@newbreedsoftware.com
  7. http://www.tuxpaint.org/
  8.  
  9. June 27, 2002 - July 12, 2007
  10. $Id: INSTALL.txt,v 1.13 2008/06/17 20:38:19 johnnypops Exp $
  11.  
  12.  
  13. Requirements:
  14. -------------
  15.   Windows Users:
  16.   --------------
  17.     The Windows version of Tux Paint comes pre-packaged with the
  18.     necessary pre-compiled libraries (in ".DLL" form), so no extra
  19.     downloading is needed.
  20.     
  21.   libSDL
  22.   ------
  23.     Tux Paint requires the Simple DirectMedia Layer Library (libSDL),
  24.     an Open Source multimedia programming library available under the
  25.     GNU Lesser General Public License (LGPL).
  26.  
  27.     Along with libSDL, Tux Paint depends on a number of other SDL 'helper'
  28.     libraries:  SDL_Image (for graphics files), SDL_TTF and (optionally)
  29.     SDL_Pango (for True Type Font support) and, optionally,
  30.     SDL_Mixer (for sound effects).
  31.  
  32.     Linux/Unix Users:
  33.     -----------------
  34.       The SDL libraries are available as source-code, or as RPM or Debian
  35.       packages for various distributions of Linux.  They can be downloaded
  36.       from:
  37.  
  38.         libSDL:      http://www.libsdl.org/
  39.         SDL_Image:   http://www.libsdl.org/projects/SDL_image/
  40.         SDL_TTF:     http://www.libsdl.org/projects/SDL_ttf/
  41.         SDL_Pango:   http://sourceforge.net/projects/sdlpango/   [OPTIONAL]
  42.         SDL_Mixer:   http://www.libsdl.org/projects/SDL_mixer/   [OPTIONAL]
  43.  
  44.       They are also typically available along with your Linux distribution
  45.       (e.g. on an installation CD, or available via package maintainance
  46.       software like Debian's "apt-get").
  47.  
  48.       NOTE: When installing from packages, be sure to ALSO install the
  49.       "-devel" versions of the packages.  (For example, install both
  50.       "SDL-1.2.4.rpm" AND "SDL-1.2.4-devel.rpm")
  51.  
  52.   Other Libraries:
  53.   ----------------
  54.     Tux Paint also takes advantage of a number of other
  55.     free, LGPL'd libraries.  Under Linux, just like SDL, they should
  56.     either already be installed, or are readily available for installation
  57.     as part of your Linux distribution.
  58.     
  59.     libPNG
  60.     ------
  61.       Tux Paint uses PNG (Portable Network Graphics) format for its
  62.       data files.  SDL_image will require libPNG be installed.
  63.  
  64.         http://www.libpng.org/pub/png/libpng.html
  65.  
  66.     gettext
  67.     -------
  68.       Tux Paint uses your system's locale settings along with the
  69.       "gettext" library to support various languages (e.g., Spanish).
  70.       You'll need the gettext library installed.
  71.  
  72.         http://www.gnu.org/software/gettext/
  73.  
  74.     libpaper (Linux/Unix only)
  75.     --------------------------
  76.       As of Tux Paint 0.9.17, Tux Paint can determine your system's
  77.       default paper size (e.g., A4 or Letter), or can be told to use a
  78.       particular paper size, thanks to libpaper.
  79.  
  80.         http://www.debian.org/
  81.  
  82.     SVG graphics support
  83.     --------------------
  84.       As of Tux Paint 0.9.17, Tux Paint can load SVG
  85.       (Scalable Vector Graphics) images as stamps.
  86.       Two sets of libraries are supported, and SVG support can be
  87.       completely disabled (via "make SVG_LIB:=")
  88.  
  89.       librsvg-2, libCairo2  [newer libraries]
  90.       --------------------------------------------------------------
  91.         libRSVG 2
  92.           http://librsvg.sourceforge.net/
  93.  
  94.         Cairo 2
  95.           http://www.cairographics.org/
  96.  
  97.         Also depends on:
  98.           GdkPixbuf
  99.           GLib
  100.             http://www.gtk.org/
  101.  
  102.           Pango
  103.             http://www.pango.org/
  104.  
  105.       Older libraries
  106.       -------------------------------
  107.         libcairo1
  108.         libsvg1
  109.         libsvg-cairo1
  110.           http://www.cairographics.org/
  111.  
  112.         Also depends on:
  113.           libxml2
  114.  
  115.     NetPBM Tools  [OPTIONAL]  [No longer used, by default]
  116.     ------------------------
  117.       Under Linux and Unix, the NetPBM tools are what are currently
  118.       used for printing.  (A PNG is generated by TuxPaint, and converted
  119.       into a PostScript using the 'pngtopnm' and 'pnmtops' NetPBM command-line
  120.       tools.)
  121.  
  122.         http://netpbm.sourceforge.net/
  123.     
  124.  
  125. Compiling and Installation:
  126. ---------------------------
  127.   Tux Paint is released under the GNU General Public License (GPL)
  128.   (see "COPYING.txt" for details), and therefore the 'source code' to
  129.   the program is included.
  130.  
  131.   Windows Users:
  132.   --------------
  133.     Compiling:
  134.     ----------
  135.       Tux Paint comes pre-compiled for Windows, so no compilation is
  136.       necessary.
  137.       
  138.       As of February 2005 (starting with Tux Paint 0.9.15), the Makefile
  139.       includes support for building on a Windows system using MinGW/MSYS.
  140.       ( http://www.mingw.org/ )
  141.       
  142.       After configuring the environment and building and installing all the 
  143.       dependencies, use these commands, in MSYS, to build, install and run:
  144.  
  145.       Prior to version 0.9.20:
  146.  
  147.     $ make win32
  148.     $ make install-win32
  149.     $ tuxpaint
  150.  
  151.       Version 0.9.20 and beyond:
  152.  
  153.     $ make
  154.     $ make install
  155.     $ tuxpaint
  156.  
  157.       Use the following command to build a version suitable for
  158.       redistribution with the installer or in a zip-file:
  159.  
  160.         $ make bdist-win32
  161.  
  162.       Or if building for Win9x/ME:
  163.  
  164.         $ BDIST_WIN9X=1 make bdist-win32
  165.  
  166.       Before any of the above will work, you need to configure the 
  167.       environment and build or install the libraries that Tux Paint depends
  168.       upon.  John Popplewell put together some instructions for doing that 
  169.       here:
  170.  
  171.         http://johnnypops.demon.co.uk/mingw/index.html
  172.       
  173.       Read the relevant notes if building for Win9X/ME.
  174.  
  175.     Installer:
  176.     ----------
  177.       Double-click the Tux Paint installer executable (.EXE file) and
  178.       follow the instructions.
  179.  
  180.       First, you will be asked to agree to the license.
  181.       (It is the GNU General Public License (GPL), which is also
  182.       available as "COPYING.txt".)
  183.  
  184.       You will then be asked whether you want to install shortcuts
  185.       to Tux Paint in your Windows Start Menu and on your Windows Desktop.
  186.       (Both options are set by default.)
  187.  
  188.       Then you will be asked where you wish to install Tux Paint.
  189.       The default should be suitable, as long as there is space available.
  190.       Otherwise, pick a different location.
  191.  
  192.       At this point, you can click 'Install' to install Tux Paint!
  193.  
  194.     Changing the Settings Using the Shortcut:
  195.     -----------------------------------------
  196.       To change program settings, right-click on the TuxPaint shortcut
  197.       and select 'Properties' (at the bottom).
  198.        
  199.       Make sure the 'Shortcut' tab is selected in the window that
  200.       appears, and examine the 'Target:' field.  You should see
  201.       something like this :
  202.  
  203.         "C:\Program Files\TuxPaint\TuxPaint.exe"
  204.  
  205.       You can now add command-line options which will be enabled when
  206.       you double-click the icon.
  207.        
  208.       For example, to make the game run in fullscreen mode,
  209.       with simple shapes (no rotation option) and in French,
  210.       add the options (after 'TuxPaint.exe'), like so:
  211.  
  212.         "C:\Program Files\TuxPaint\TuxPaint.exe" -f -s --lang french
  213.  
  214.       (See "README.txt" for a full list of available command-line options.)
  215.        
  216.       If you make a mistake or it all disappears use Ctrl-Z to undo or
  217.       just hit the [ESC] key and the box will close with no changes made
  218.       (unless you pushed the "Apply" button!).
  219.        
  220.       When you have finished, click "OK."
  221.  
  222.     If Something Goes Wrong
  223.     -----------------------
  224.       If, when you double-click on the shortcut to run the game,
  225.       nothing happens, it is probably because some of these command-line
  226.       options are wrong. Open an Explorer like before, and look for a file
  227.       called 'stderr.txt' in the TuxPaint folder.
  228.     
  229.       It will contain a description of what was wrong. Usually it will
  230.       just be due to incorrect character-case (capital 'Z' instead
  231.       of lowercase 'z') or a missing (or extra) '-' (dash).
  232.   
  233.   
  234.   Linux/Unix Users:
  235.   -----------------
  236.     Compiling:
  237.     ----------
  238.       Note: Currently, Tux Paint does not use autoconf/automake, so there
  239.       is no "./configure" script to run.  (Sorry!)  Compiling should be
  240.       straight-forward though, assuming everything Tux Paint needs is installed.
  241.  
  242.       To compile the program from source, simply run the following command
  243.       from a shell prompt (e.g., "$"):
  244.  
  245.         $ make
  246.  
  247.     Disabling SVG support (and hence Cairo, libSVG and svg-cairo dependencies):
  248.     ---------------------------------------------------------------------------
  249.       To disable SVG support (e.g., if your system is not currently supported
  250.       by the Cairo library or other SVG-related dependencies), you can
  251.       run "make" with "SVG_LIB= SVG_CFLAGS= NOSVGFLAG=NOSVG" added:
  252.  
  253.         $ make SVG_LIB= SVG_CFLAGS=
  254.  
  255.     Disabling Pango support (and hence Pango, Cairo, etc. dependencies):
  256.     --------------------------------------------------------------------
  257.       Prior to version 0.9.18, Tux Paint used the libSDL_ttf library for
  258.       rendering text using TrueType Fonts.  Since 0.9.18, libSDL_Pango is
  259.       used, as it has much greater support for internationalization.
  260.       However, if you wish to disable the use of SDL_Pango, you may do so
  261.       running "make" with "SDL_PANGO_LIB=" added:
  262.  
  263.         $ make SDL_PANGO_LIB=
  264.  
  265.     Disabling Sound at Compile-time:
  266.     --------------------------------
  267.       If you don't have a sound card, or would prefer to build the program
  268.       with no sound support (and therefore without a the SDL_mixer dependency),
  269.       you can run "make" with "SDL_MIXER_LIB=" added:
  270.  
  271.         $ make SDL_MIXER_LIB=
  272.  
  273.     If you get errors:
  274.     ------------------
  275.       If you receive any errors during compile-time, make sure you have
  276.       the appropriate libraries installed (see above).  If using packaged
  277.       versions of the libraries (e.g., RPMs under RedHat or DEBs under Debian),
  278.       be sure to get the corresponding "-dev" or "-devel" packages as well,
  279.       otherwise you won't be able to compile Tux Paint (and other programs)
  280.       from source!
  281.  
  282.  
  283.     Installing:
  284.     -----------
  285.       Assuming no fatal errors occured, you can now install the program
  286.       so that it can be run by users on the system.  By default, this must
  287.       be done by the "root" user ('superuser').  Switch to "root" by
  288.       typing the command:
  289.  
  290.         $ su
  291.  
  292.       Enter "root"'s password at the prompt.  You should now be "root"
  293.       (with a prompt like "#").  To install the program and its
  294.       data files, type:
  295.  
  296.         # make install
  297.  
  298.       Finally, you can switch back to your regular user by exiting
  299.       superuser mode:
  300.  
  301.         # exit
  302.  
  303.  
  304.       Alternatively, you may be able to simply use the "sudo" command
  305.       (e.g., on Ubuntu Linux):
  306.  
  307.         $ sudo make install
  308.  
  309.  
  310.       NOTE: By default, "tuxpaint", the executable program, is
  311.       placed in "/usr/local/bin/".  The data files (images, sounds, etc.)
  312.       are placed in "/usr/local/share/tuxpaint/".
  313.  
  314.  
  315.       Changing Where Things Go
  316.       ------------------------
  317.         You can change where things will go by setting Makefile variables
  318.         on the command line.  DESTDIR is used to place output in a staging
  319.         area for package creation. "PREFIX" is the basis of where all other
  320.         files go, and is, by default, set to "/usr/local".
  321.  
  322.         Other variables are:
  323.           BIN_PREFIX
  324.         Where the "tuxpaint" binary will be installed.
  325.         (Set to "$(PREFIX)/bin" by default - e.g., "/usr/local/bin")
  326.       
  327.       DATA_PREFIX
  328.         Where the data files (sound, graphics, brushes, stamps, fonts)
  329.          will go, and where Tux Paint will look for them when it's run.
  330.         (Set to "$(PREFIX)/share/tuxpaint")
  331.     
  332.       DOC_PREFIX
  333.         Where the documentation text files (the "docs" directory) will go.
  334.         (Set to "$(PREFIX)/share/doc/tuxpaint")
  335.     
  336.       MAN_PREFIX
  337.         Where the manual page for Tux Paint will go.
  338.         (Set to "$(PREFIX)/share/man")
  339.     
  340.       ICON_PREFIX                      $(PREFIX)/share/pixmaps
  341.       X11_ICON_PREFIX                  $(PREFIX)/X11R6/include/X11/pixmaps
  342.       GNOME_PREFIX                     $(PREFIX)/share/gnome/apps/Graphics
  343.       KDE_PREFIX                       $(PREFIX)/share/applnk/Graphics
  344.         Where the icons and launchers (for GNOME and KDE) will go.
  345.     
  346.       LOCALE_PREFIX
  347.         Where the translation files for Tux Paint will go, and where
  348.         Tux Paint will look for them.
  349.         (Set to "$(PREFIX)/share/locale/")
  350.         (Final location of a translation file will be
  351.         under the locale's directory (e.g., "es" for Spanish),
  352.         within the "LC_MESSAGES" subdirectory.)
  353.  
  354.         FIXME: This list is out of date.  See Makefile and Makefile-i18n for
  355.         a complete list.
  356.     
  357.     
  358. Uninstalling Tux Paint:
  359. -----------------------
  360.   Windows
  361.   -------
  362.     Using the Uninstaller
  363.     ---------------------
  364.       If you installed the Start Menu shortcuts (the default), then go to the 
  365.       TuxPaint folder and select "Uninstall". A box will be displayed that will 
  366.       confirm that you are about to uninstall Tux Paint and, if you are certain
  367.       that you want to permanently remove Tux Paint, click on the 'Uninstall'
  368.       button. 
  369.  
  370.       When it has finished, click on the close button.
  371.  
  372.       It is also possible to use the entry "TuxPaint (remove only)" in the
  373.       Control Panel Add/Remove programs section.
  374.  
  375.       NOTE: because the pictures that are created are saved inside the Tux Paint 
  376.       folder, this folder and the 'userdata' folder inside it are NOT removed.
  377.  
  378.  
  379.   Linux
  380.   -----
  381.     Within the Tux Paint source directory (where you compiled Tux Paint),
  382.     you can use a 'Makefile' target to uninstall Tux Paint.
  383.     By default, this must be done by the "root" user ('superuser').
  384.     (See the installation instructions above for further information.)
  385.  
  386.     Switch to "root" by typing the command:
  387.  
  388.       $ su
  389.  
  390.     Enter "root"'s password at the prompt.  You should now be "root"
  391.     (with a prompt like "#").  To uninstall the program and its data files
  392.     (the default rubber-stamp images, if any, will also be removed), type:
  393.  
  394.       # make uninstall
  395.  
  396.     Finally, you can switch back to your regular user by exiting
  397.     superuser mode:
  398.  
  399.       # exit
  400.  
  401.